home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 008a / drx108.zip / DIRX.DOC < prev    next >
Text File  |  1992-01-01  |  14KB  |  315 lines
  1. DirX-Directory of eXecutables, Version 1.08             01-Jan-92
  2.  
  3.  
  4. Files compressed with AXE, DIET, EXEPACK, ICE, LEXEM, LZEXE, PKLITE,
  5. SCRNCH, SHRINK & TINYPROG are displayed in the left window.  Uncompressed
  6. COM/EXE files are displayed in the right window.  Compress and uncompress
  7. individual and groups of files from within the program.  Navigate between
  8. drives/directories by pointing and shooting.  New:  Extends recognition of
  9. files compressed with LZEXE (hacked headers) and DIET (additional headers).
  10.  
  11. Contents:
  12. =========
  13. Purpose
  14. Displayed data
  15. Syntax
  16. Switches
  17. Configuration
  18. Commands
  19. Pull-down menus
  20.  
  21. Purpose:
  22. ========
  23. To provide a simple means of easily showing which files have and have not
  24. been compressed with an executable file compressor.  It allows for easy
  25. compression and uncompression of individual and groups of files by
  26. user-selectable compression/uncompression programs.
  27.  
  28. DirX is a free program.
  29.  
  30. Displayed data:
  31. ===============
  32. When the program is started, two windows pop up displaying any compressed
  33. files and/or directories on the left and any non-compressed files on the
  34. right.  The window on the left is slightly wider to allow an abbreviated
  35. three-character identifier to precede each filename - currently "axe",
  36. "die", "epk", "ice", "lex", "lze", "pkl", "scr", "shr" or "tny" for files
  37. compressed with AXE, DIET, EXEPACK, ICE, LEXEM, LZEXE, PKLITE, SCRNCH,
  38. SHRINK or TINYPROG, respectively.
  39.  
  40. In addition to the file name, and type in the compressed window, the
  41. default display also shows the file size, date and time for each file.
  42. Using the "Toggle" command, the current window can be set to show any
  43. special characteristics ("Special"), file attributes ("Attr"), the probable
  44. correct extension for the file name if it has been misnamed ("Mis") and
  45. which version of the compressor was used in the case of DIET, LZEXE, PKLITE
  46. and TINYPROG files.
  47.  
  48. Please note that as DIET, at least up until version 1.10, does not
  49. explicitly store the version number, any version number greater than 1.00
  50. can only be interpreted in the "greater than or equal to" sense.  Thus a
  51. reading of "1.01" means that a version of DIET equal to 1.01, or higher,
  52. was used to compress a file.
  53.  
  54. Files compressed with PKLITE Professional's extra-compression option have
  55. an 'e' appended to the version number.
  56.  
  57. Special characteristics displayed using the Toggle command are as follows:
  58. For the Compressed window, "dat" for "data" files (non-executables)
  59. compressed with DIET.  For the Uncompressed window, "ovl" for possible
  60. executables containing overlays, "win" for Windows/OS2 executables and
  61. "lhi" for LoadHi executables.
  62.  
  63. The program attempts to sense the type of display used and adjust color
  64. appropriately.  However, if the user has a color graphics card, but no
  65. color monitor, the display may be improved by using the DOS command "MODE
  66. BW80".  Conversely, if you do have a color monitor, but the program
  67. displays in "black and white", try using "MODE CO80".
  68.  
  69. Alternatively, two switches are available from the command line to force
  70. black-and-white and color modes.  See "Switches" below.
  71.  
  72. EGA/43- and VGA/50-line modes are supported.  At program startup, an
  73. attempt is made to detect the actual number of lines on the screen, up to a
  74. maximum of 50, and to adjust the display accordingly.
  75.  
  76. Syntax:
  77. =======
  78.      Usage:  DIRX [switches] [d:][path][filespec] [switches]
  79.  
  80. In the above syntax, if no argument follows the program name, the current
  81. default directory is searched, which is equivalent to "DIRX *.*".  If no
  82. file extension is specified, all extensions are searched.
  83.  
  84. Switches:
  85. =========
  86.      -a:  display Alternate info for both windows on startup.  Simpler than
  87.           selecting each window in turn from within the program and using
  88.           the Toggle command twice.
  89.  
  90.      -b:  force Black-and-white mode.  Provided as an alternative to using
  91.           DOS's "MODE BW80" command.
  92.  
  93.      -c:  force Color mode.  Provided as an alternatative to using DOS's
  94.           "MODE CO80" command.
  95.  
  96. Either '/' or '-' may be used to specify switches.
  97.  
  98. Entering an invalid switch causes the program display a brief help screen
  99. then exit.
  100.  
  101. Examples:
  102.  
  103.      DIRX /h
  104.      DIRX -?
  105.  
  106. Configuration:
  107. ==============
  108. The user may create or edit a file named DIRX.CFG using an editor or word
  109. processor which can save pure ASCII text files.  DIRX.CFG should reside on
  110. the PATH, or in the current directory, when DirX is run.
  111.  
  112. In searching your path for DIRX.CFG, only the first 127 characters of the
  113. PATH statement are significant.  For "extended" paths (PATH statements
  114. longer than 127 characters), please make sure that the path containing
  115. DIRX.CFG is completely specified before the 127-character limit has been
  116. reached.
  117.  
  118. The contents of DIRX.CFG allow the user to specify which program will be
  119. invoked for compressing uncompressed files and which program(s) to use for
  120. uncompressing the related types of compressed files (axe, die, epk, ice,
  121. lex, lze, pkl, scr, shr, tny).  Although the syntax of DIRX.CFG allows for
  122. uncompression programs for any of the supported formats, the related
  123. uncompressing program for a particular type may not exist at the present
  124. time.
  125.  
  126. The syntax for specifying the *single* compression program is:
  127.  
  128. /C="prognam {filespec | options}"
  129.  
  130. Where:  "prognam" is the name of the program to execute
  131.         "filespec" are format specifiers passed to "prognam" as filenames
  132.         "options" are usually switches passed to "prognam"
  133.  
  134. "filespec" may be created by a concatenation of the "%f" and "%e" format
  135. specifiers.
  136.  
  137. If "filename.ext" is a target file, then %f represents the "filename"
  138. portion of the complete filename, and %e represents the ".ext" part.
  139.  
  140. If no format specifiers are detected, then the current target filename is
  141. simply appended to the end of the "prognam ... " string.  This is for
  142. compatibility with DIRX.CFG files created for use with versions of DirX
  143. prior to 1.05.
  144.  
  145. Specific examples follow:
  146.  
  147. /C="PKLITE %f%e"
  148.  
  149. /C="AXE %f%e -n"
  150.  
  151. /C="EXEPACK %f%e %f.EPK"
  152.  
  153. /C="DIET"    <- older syntax, but still works
  154.  
  155. If DIRX.CFG contains more than one line with the correct syntax for
  156. specifying the compression program, the last one encountered before end of
  157. file will be used.
  158.  
  159. The default command for specifying the method of compression may be
  160. temporarily overridden from within the program.  More about this later in
  161. the "Commands" section.
  162.  
  163. The syntax for specifying the uncompression program(s) is:
  164.  
  165. /U<xxx>="prognam {filespec | options}"
  166.  
  167. Where <xxx> is "axe", "die", "epk", "ice", "lex", "lze", "pkl", "scr",
  168. "shr" or "tny" for files compressed with AXE, DIET, EXEPACK, ICE, LEXEM,
  169. LZEXE, PKLITE, SCRNCH, SHRINK or TINYPROG, respectively.
  170.  
  171. "prognam", "filespec" and "options" have the same meanings as discussed
  172. above for specifying the compress command.
  173.  
  174. Specific examples follow:
  175.  
  176. /Upkl="PKLITE %f%e -x"
  177.  
  178. /Udie="DIET -ra %f%e"
  179.  
  180. /Uepk="UPACKEXE %f%e"
  181.  
  182. If DIRX.CFG contains more than one line with the correct syntax for
  183. specifying the uncompression program for the related type of compressed
  184. file, the last one encountered before end of file will be used.
  185.  
  186. In the above syntax for DIRX.CFG, neither leading and trailing spaces, nor
  187. any other extraneous characters are allowed.  Lines with invalid syntax,
  188. including invalid format specifiers, are simply ignored.  This may actually
  189. be used to advantage, as shown in the *sample* DIRX.CFG file, where the
  190. single quote character is used to "comment-out" some of the non-applicable
  191. lines, but where the user may want to retain these lines to save retyping
  192. should he/she want to later change which is the default compression
  193. program, for example.
  194.  
  195. The sample DIRX.CFG file is included in the distribution archive, which the
  196. user may edit to "customize" DirX's behavior.
  197.  
  198. Commands:
  199. =========
  200. The current or active window is the one with the solid frame.  Within the
  201. active window, <Home>, <End>, <PgUp>, <PgDn>, <UpArrow> and <DownArrow> may
  202. be used to navigate.  The <Tab> and right/left arrow keys will toggle the
  203. active window between the left and right panels.
  204.  
  205. If any directories are displayed in the left (Compressed) window, moving
  206. the file selection bar (highlight) over that directory and pressing
  207. <Return> will change the directory being viewed.  The file lists will be
  208. updated automatically.
  209.  
  210. Two shortcut keys are available for navigating directories while in the
  211. Compressed window:
  212.  
  213. "Ctrl \" changes the current directory to the root directory - similar to
  214. "CD \" at the DOS level.
  215.  
  216. "Ctrl <PgUp>" changes the current directory to the parent directory -
  217. similar to "CD .." from DOS.
  218.  
  219. To change the current default drive from within the program, use either
  220. "Alt <F1>" or "Alt <F2>".  A window indicating valid drives will pop up,
  221. allowing the user to select another drive by moving the highlight with the
  222. left and right arrow keys, then pressing <Return> to select the new drive.
  223. As an alternative, you may also type the letter of the drive.  Press <Esc>
  224. to leave the default drive unchanged.  The drive changing feature is only
  225. valid when using versions of DOS numbered 3.0 or higher.
  226.  
  227. Pressing <F1> or the letter 'H' will display a brief help screen
  228. summarizing commonly used commands.  Press any key to close the help
  229. window.
  230.  
  231. Pressing <F3> or the letter 'D' will turn Directories-only mode on.  To
  232. turn Directories-only mode off, press <F3> or 'D' a second time.  (This
  233. feature was added by user request to speed up navigation on a relatively
  234. slow machine.)
  235.  
  236. Pressing <F4> or the letter 'T' will toggle the active window's display to
  237. show additional information on the files being displayed, as previously
  238. described in the "Displayed data" section above.
  239.  
  240. Pressing <F6> or the letter 'M' when no files have been selected will cause
  241. the Move command to act on the currently highlighted file.  If any files
  242. have been selected, the Move command acts on the selected files.
  243.  
  244. If the Move command is given while in the "Compressed" window, the DOS
  245. command "<uncompPrognam> <filename>" is executed for each selected file,
  246. where <uncompPrognam> is the name of the uncompression program and
  247. <filename> is the name of the file to uncompress.
  248.  
  249. If the Move command is given while in the "Uncompressed" window, the DOS
  250. command "<compPrognam> <filename>" is executed for each selected file,
  251. where <compPrognam> is the name of the compression program and <filename>
  252. is the name of the file to compress.
  253.  
  254. Pressing "Alt <F6>" or "Alt M" from either the Compressed or Uncompressed
  255. window will open an input window which will allow the user to temporarily
  256. "Alter", or override, the method of compression currently defined in
  257. DIRX.CFG, on the fly, from within DirX.
  258.  
  259. For compressing/uncompressing to work, the commands <compPrognam> and/or
  260. <uncompPrognam> should either be available in a directory included in the
  261. PATH environment variable, or in the current directory.  Tip:  Either of
  262. these "programs" may be batch files.
  263.  
  264. Files may be selected, or tagged, either individually or by wildcard
  265. selection.  The <Ins> key may be used as a toggle to select and unselect
  266. individual files.  Pressing <Ins> on an unselected file selects it.
  267. Pressing <Ins> on a selected file unselects it.  To select a group of files
  268. using DOS-type wildcards, press the plus ('+') key.  This opens up an input
  269. window into which a file specification may be entered.  To unselect a group
  270. of files, press the minus ('-').  This opens up an input window similar to
  271. the one for selection.  The suggested keys are the gray plus and minus keys
  272. found near the numeric keypad of many keyboards.
  273.  
  274. Pressing <F7> or the letter 'S' will open an input window for the user to
  275. enter a file specification to search for within the current window.  If
  276. wildcards are used, and the Search command is repeatedly invoked without
  277. changing the search specification, the program will cycle through all
  278. matching file names.
  279.  
  280. Pressing <F9> or the letter 'P' or '/' will invoke the pull-down menu
  281. system.
  282.  
  283. Pressing <Esc>, <F10> or the letter 'Q' will exit the program.
  284.  
  285. Pull-down menus:
  286. ================
  287. The pull-down menu system duplicates in functionality many of the commands
  288. already described in the Commands section.  The purpose of this menu system
  289. is to de-emphasize the use of function keys and cryptic Alt- and Ctrl-key
  290. sequences when adding new commands in the future.
  291.  
  292. The Move command, invoked by function key, is replaced by two separate
  293. commands in the pull-down menu system.  These are the "Compress" and
  294. "Uncompress" commands, listed under the "File" submenu.
  295.  
  296. For the Uncompress command to work, the Compressed window must be the
  297. current one.  This command is equivalent to using the Move command while in
  298. the Compressed window.
  299.  
  300. The Compress command, depending on which window is active, can act on files
  301. in *either* the Compressed or Uncompressed windows.  The purpose of
  302. allowing the user to *attempt to* compress already compressed files
  303. (something that is available from the command line anyway) is to facilitate
  304. experimentation on the effects of compression by a variety of methods -
  305. compressing files already compressed with EXEPACK, for example.
  306.  
  307. --
  308.  
  309.                 Raymond T. Kaya
  310.                 P. O. Box 1436
  311.                 Honolulu, HI  96806
  312.  
  313.                 CompuServe:  71230,2500
  314.                 GEnie     :  R.KAYA1
  315.